Retrieve Counterparty Members

GET /api/v1/Counterparties/groups/members

Description

This endpoint is used to retrieve a list of members of a specific counterparty group. It returns a CounterpartyGroupMemberListPagedResponse object containing information about the members.

Headers:

• None

ApiKey:

• No API key required

Content-Type:

• text/plain

• application/json

• text/json

Path Parameters:

• version: string, required

Query Parameters:

• GroupId: string, required, the id of the counterparty group whose members are to be retrieved.

• PageSize: integer, optional, the number of items to retrieve per page. Defaults to 10 if not specified.

• PageNumber: integer, optional, the page number of the items to retrieve. Defaults to 1 if not specified.

Request Body:

• None

URL:

• GET: {{baseUrl API url}}/api/v1/Counterparties/groups/members?GroupId={GroupId}&PageSize={PageSize}&PageNumber={PageNumber}

Response:

• A CounterpartyGroupMemberListPagedResponse object containing information about the members.

Error Codes:

• 400: Bad Request

• 404: Resource not found

• 500: Internal server error

Example:

Request:

GET /api/v1/Counterparties/groups/members?GroupId=1234567890&PageSize=10&PageNumber=1

Response:

HTTP/1.1 200 OK
{
  "members": [
    {
      "id": "1234567890",
      "name": "John Doe",
      "role": "Administrator"
    },
    {
      "id": "abc123",
      "name": "Jane Smith",
      "role": "Manager"
    }
  ],
  "totalCount": 2,
  "pageNumber": 1,
  "pageSize": 10,
  "totalPages": 1
}

Method: GET

/api/v1/Counterparties/groups/members?GroupId=<uuid>&PageSize=<integer>&PageNumber=<integer>

Headers

Content-Type	Value
Accept	text/plain

Query Params

Param	value
GroupId	<uuid>
PageSize	<integer>
PageNumber	<integer>

Response: 200

{
  "pageNumber": "<integer>",
  "pageSize": "<integer>",
  "total": "<integer>",
  "succeeded": "<boolean>",
  "message": "<string>",
  "errors": [
    "<string>",
    "<string>"
  ],
  "data": [
    {
      "id": "<uuid>",
      "counterpartyId": "<uuid>",
      "counterpartyName": "<string>",
      "counterpartyGroupId": "<uuid>"
    },
    {
      "id": "<uuid>",
      "counterpartyId": "<uuid>",
      "counterpartyName": "<string>",
      "counterpartyGroupId": "<uuid>"
    }
  ]
}